跳至主要内容
版本：V4.0

場景管理API

獲取場景列表​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
page_sizeIntegerBody是每頁數量
page_indexIntegerBody是當前頁數

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明​

參數名類型位置說明
scene_idStringBody場景ID
scene_nameStringBody場景名稱
enable_autoBooleanBody判斷是否啓用自動化
true：啓用
false：禁用

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_scene_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db",
      "scene_name": "my scene",
      "enable_auto": true
    }
  ]
}

失敗返回示例​

見 接口失敗返回


獲取場景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
scene_idStringBody是場景ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObject<result>Body返回結果

result說明​

參數名類型位置說明
scene_nameStringBody場景名稱
triggers[]Object<trigger>Body觸發器信息
actions[]Object<action>Body動作信息

trigger說明​

參數名類型位置說明
trigger_configStringBody觸發器配置，見 場景觸發器配置
trigger_typeStringBody觸發器類型，見 場景觸發器配置
room_tag_idStringBody房間標籤ID

action說明​

參數名類型位置說明
action_configStringBody動作配置，見 場景動作配置
ability_typeStringBody能力類型
action_typeStringBody動作類型，見 場景動作配置
attributeObjectBody附加屬性，見 標準物模型

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "scene_name": "my scene",
      "triggers": [
        {
          "trigger_config": "hotel",
          "trigger_type": "check_in",
          "room_tag_id": ""
        }
      ],
      "actions": [
        {
          "action_config": "device",
          "ability_type": "light",
          "action_type": "turn_all_on"
        }
      ]
    }
  ]
}

失敗返回示例​

見 接口失敗返回


創建場景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
scene_nameStringBody是場景名稱
triggers[]Object<trigger>Body是觸發器信息
actions[]Object<action>Body是動作信息

trigger說明​

參數名類型位置必填說明
trigger_configStringBody是觸發器配置，見 場景觸發器配置
trigger_typeStringBody是觸發器類型，見 場景觸發器配置
room_tag_idStringBody否房間標籤ID

action說明​

參數名類型位置必填說明
action_configStringBody是動作配置，見 場景動作配置
ability_typeStringBody是能力類型
action_typeStringBody是動作類型，見 場景動作配置
attributeObjectBody否附加屬性，見 標準物模型

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObject<result>Body返回結果

result說明​

參數名類型位置說明
scene_idStringBody場景ID

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_name": "test",
    "triggers": [
      {
        "trigger_config": "hotel",
        "trigger_type": "check_in"
      }
    ],
    "actions": [
      {
        "action_config": "device",
        "ability_type": "light",
        "action_type": "turn_all_on"
      }
    ]
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "scene_id": "sr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

失敗返回示例​

見 接口失敗返回


更新場景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
scene_idStringBody是場景ID
scene_nameStringBody是場景名稱
triggers[]Object<trigger>Body是觸發器信息
actions[]Object<action>Body是動作信息

trigger說明​

參數名類型位置必填說明
trigger_configStringBody是觸發器配置，見 場景觸發器配置
trigger_typeStringBody是觸發器類型，見 場景觸發器配置
room_tag_idStringBody否房間標籤ID

action說明​

參數名類型位置必填說明
action_configStringBody是動作配置，見 場景動作配置
ability_typeStringBody是能力類型
action_typeStringBody是動作類型，見 場景動作配置
attributeObjectBody否附加屬性，見 標準物模型

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "sr31adc223cc4b3bedb6bd4742dedcfa5",
    "scene_name": "test",
    "triggers": [
      {
        "trigger_config": "hotel",
        "trigger_type": "check_in"
      }
    ],
    "actions": [
      {
        "action_config": "device",
        "ability_type": "light",
        "action_type": "turn_all_on"
      }
    ]
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回


刪除場景信息​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
scene_idStringBody是場景ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_scene_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db"
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回


手動觸發場景​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
scene_idStringBody是場景ID
residences[]Object<residence>Body是住宅信息

residence說明​

參數名類型位置必填說明
residence_idStringBody是住宅ID

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "manual_trigger_scene",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s3b5a73f8dd84abaa94dcs248be49b0db",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回


啓用自動化場景​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
scene_idStringBody是場景ID
enable_autoBooleanBody是判斷是否啓用自動化
true：啓用
false：禁用

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "enable_auto_scene",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "scene_id": "s3b5a73f8dd84abaa94dcs248be49b0db",
    "enable_auto": true
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例​

見 接口失敗返回


獲取場景歷史記錄​

接口地址​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

請求參數​

參數名類型位置必填說明
Content-TypeStringHeader是內容類型，值爲application/json
AcceptStringHeader是接受類型，值爲application/json
AuthorizationStringHeader是Bearer認證，訪問令牌
commandStringBody是命令名稱
idStringBody是命令ID
paramObject<param>Body是命令參數

param說明​

參數名類型位置必填說明
page_sizeIntegerBody是每頁數量
page_indexIntegerBody是當前頁數

返回參數​

參數名類型位置說明
Content-TypeStringHeader內容類型，值爲application/json
successBooleanBody判斷請求是否成功
true：成功
false：失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明​

參數名類型位置說明
scene_record_idStringBody場景記錄ID
scene_idStringBody場景ID
scene_nameStringBody場景名稱
trigger_sceneBooleanBody判斷場景執行是否成功
true：成功
false：失敗
residence_idStringBody住宅ID
detailObject<detail>Body詳細信息

detail說明​

參數名類型位置說明
trigger_configStringBody觸發器配置，見 場景觸發器配置
trigger_typeStringBody觸發器類型，見 場景觸發器配置
room_tag_idStringBody房間標籤ID
manualBooleanBody判斷是否是手動觸發
true：是
false：否
manual_byStringBody手動執行人

請求示例​

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_scene_history",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

成功返回示例​

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "scene_record_id": "r8b5a73f8dd84abaa94dcs248be49b0d1",
      "scene_id": "s8b5a73f8dd84abaa94dcs248be49b0db",
      "scene_name": "my scene",
      "trigger_scene": true,
      "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
      "detail": {
        "trigger_config": "hotel",
        "trigger_type": "check_in",
        "room_tag_id": "",
        "manual": false,
        "manual_by": ""
      }
    }
  ]
}

失敗返回示例​

見 接口失敗返回